Status monitoring and progress tracking

This page explains the real-time status monitoring and progress tracking system for bulk messaging operations. It covers the event-driven status reporting pipeline, including client initialization and authentication, QR code generation, progress updates during message sending, and the frontend UI integration that displays live feedback. It also documents the status message types, progress tracking interface, error reporting, and troubleshooting guidance.

The status monitoring spans three layers:

• Electron Main Process: Initializes clients, emits status events, and manages long-running operations.
• Preload Bridge: Exposes secure IPC channels to the renderer for receiving status updates.
• Renderer (React): Subscribes to status events, renders real-time UI updates, and aggregates activity logs.

graph TB
subgraph "Electron Main Process"
M["main.js<br/>Client lifecycle & events"]
GH["gmail-handler.js<br/>Gmail progress events"]
SH["smtp-handler.js<br/>SMTP progress events"]
end
subgraph "Preload Bridge"
P["preload.js<br/>IPC exposure"]
end
subgraph "Renderer (React)"
BM["BulkMailer.jsx<br/>Event subscriptions"]
WF["WhatsAppForm.jsx<br/>Status display & logs"]
end
M --> P
GH --> P
SH --> P
P --> BM
BM --> WF

• WhatsApp client lifecycle and status events:
  • Client initialization, QR code generation, authentication, readiness, and disconnection events are emitted to the renderer.
  • Progress events during mass sending include per-contact status and final summary.
• Gmail and SMTP progress reporting:
  • Per-message progress events include current index, total count, recipient, and status (“sending”, “sent”, “failed”).
• Renderer integration:
  • Event subscriptions for status, QR, and send progress.
  • Real-time UI updates and activity log aggregation.

The status monitoring follows an event-driven pattern:

• Main process emits events for client status, QR code, and send progress.
• Preload exposes IPC listeners to the renderer.
• Renderer subscribes to events and updates UI and logs.

sequenceDiagram
participant UI as "WhatsAppForm.jsx"
participant BM as "BulkMailer.jsx"
participant P as "preload.js"
participant M as "main.js"
UI->>BM : User clicks "Connect to WhatsApp"
BM->>P : invoke("whatsapp-start-client")
P->>M : IPC invoke
M-->>P : Client initialized
M-->>P : "Initializing WhatsApp client..."
P-->>BM : onWhatsAppStatus callback
BM-->>UI : Update status text
M-->>P : "Scan QR code to authenticate"
M-->>P : QR data URL
P-->>BM : onWhatsAppQR callback
BM-->>UI : Render QR image
M-->>P : "Client is ready!"
M-->>P : "Authenticated!"
P-->>BM : onWhatsAppStatus callbacks
BM-->>UI : Update status and clear QR
UI->>BM : Click "Send Mass Messages"
BM->>P : invoke("whatsapp-send-messages")
loop For each contact
M-->>P : "Sent to +123..." or "Failed to send..."
P-->>BM : onWhatsAppSendStatus callback
BM-->>UI : Append to results/log
end
M-->>P : "Mass messaging complete. Sent : X, Failed : Y"
P-->>BM : Final summary
BM-->>UI : Show totals

WhatsApp status reporting pipeline#

• Client lifecycle events:
  • Initialization, QR generation, ready, authenticated, auth failure, and disconnect notifications are sent to the renderer.
• QR code generation:
  • QR string is converted to a data URL and sent to the renderer for display.
• Progress tracking during mass sending:
  • Per-contact status updates (“Sent to…”, “Failed to send…”).
  • Final summary with sent and failed counts.

sequenceDiagram
participant M as "main.js"
participant P as "preload.js"
participant BM as "BulkMailer.jsx"
participant WF as "WhatsAppForm.jsx"
M-->>P : "Initializing WhatsApp client..."
P-->>BM : onWhatsAppStatus
BM-->>WF : Update status
M-->>P : "Scan QR code to authenticate"
M-->>P : QR data URL
P-->>BM : onWhatsAppQR
BM-->>WF : Render QR
M-->>P : "Client is ready!"
M-->>P : "Authenticated!"
P-->>BM : onWhatsAppStatus
BM-->>WF : Clear QR and update status
M-->>P : "Sending messages to N contacts..."
loop For each contact
M-->>P : "Sent to +123..." or "Failed to send..."
P-->>BM : onWhatsAppSendStatus
BM-->>WF : Append to results
end
M-->>P : "Mass messaging complete. Sent : X, Failed : Y"
P-->>BM : Final summary
BM-->>WF : Show totals

Gmail and SMTP progress tracking#

• Both handlers emit per-message progress events with:
  • current index
  • total count
  • recipient
  • status (“sending”, “sent”, “failed”)
• Failed messages include an error message payload for detailed troubleshooting.

sequenceDiagram
participant BM as "BulkMailer.jsx"
participant P as "preload.js"
participant GH as "gmail-handler.js"
participant SH as "smtp-handler.js"
BM->>P : invoke("send-email") or invoke("smtp-send")
P->>GH : IPC invoke (Gmail)
P->>SH : IPC invoke (SMTP)
loop For each recipient
GH-->>P : email-progress {status : "sending"}
SH-->>P : email-progress {status : "sending"}
GH-->>P : email-progress {status : "sent" | "failed", error?}
SH-->>P : email-progress {status : "sent" | "failed", error?}
P-->>BM : onProgress callback
BM-->>UI : Update results/log
end

Status message types and interpretation#

• WhatsApp client status:
  • Initializing WhatsApp client…
  • Scan QR code to authenticate
  • Client is ready!
  • Authenticated!
  • Authentication failed:
  • Client disconnected:
  • Starting WhatsApp client…
  • Failed to initialize client:
  • Disconnected
  • Disconnected (forced)
• WhatsApp send progress:
  • Sending messages to N contacts…
  • Sent to
  • Failed: not registered
  • Failed to send to :
  • Mass messaging complete. Sent: X, Failed: Y
• Email progress (Gmail/SMTP):
  • email-progress with status “sending”, “sent”, or “failed”
  • Includes current/total and recipient
  • “failed” includes error message

Interpretation guidelines:

• “Initializing” and “Starting” indicate setup phase.
• “Scan QR code” indicates authentication required.
• “Client is ready” and “Authenticated” indicate operational state.
• “Failed” or “Authentication failed” indicates errors requiring action.
• “Sending” indicates ongoing operation; “sent” indicates success; “failed” indicates error with details.

Progress tracking interface#

• Sent/Failed counts:
  • Final summary after mass sending includes total sent and failed.
• Individual recipient status:
  • Each status update is appended to the activity log with timestamp and color-coded indicators.
• Real-time rendering:
  • Status text updates immediately upon receiving events.
  • QR code appears/disappears based on authentication state.

Error reporting system#

• WhatsApp:
  • Authentication failures report the reason.
  • Disconnection reasons are reported.
  • Initialization failures include error messages.
  • Per-contact send failures include the error message.
• Gmail/SMTP:
  • Detailed error messages are attached to “failed” progress events.
  • Transport verification and token presence are validated before sending.

Troubleshooting guidance:

• WhatsApp QR code not loading:
  • Retry connection; check network and browser cache.
• Authentication failures:
  • Verify credentials and service availability.
• SMTP connection issues:
  • Confirm host/port/security settings and firewall rules.
• Contact import errors:
  • Validate file format and encoding.

Integration with frontend UI#

• Event subscriptions:
  • onWhatsAppStatus, onWhatsAppQR, onWhatsAppSendStatus for WhatsApp.
  • onProgress for email progress.
• UI updates:
  • Status text color changes based on state (ready, initializing, error).
  • QR code displayed until authenticated.
  • Activity log shows chronological status updates with color-coded severity.

The status monitoring relies on:

• Electron IPC for secure event transport.
• whatsapp-web.js for WhatsApp client lifecycle and messaging.
• qrcode for QR code generation.
• googleapis and nodemailer for Gmail and SMTP progress reporting.

graph LR
PJSON["package.json<br/>Dependencies"] --> WWeb["whatsapp-web.js"]
PJSON --> QR["qrcode"]
PJSON --> GA["googleapis"]
PJSON --> NM["nodemailer"]
MJS["main.js"] --> WWeb
MJS --> QR
GHJS["gmail-handler.js"] --> GA
SHJS["smtp-handler.js"] --> NM

• Rate limiting:
  • Delays between messages reduce the risk of throttling and improve reliability.
• Asynchronous processing:
  • Events are emitted asynchronously to keep the UI responsive.
• Efficient rendering:
  • Only appending new log entries prevents unnecessary re-renders.

Common issues and resolutions:

• WhatsApp QR code not loading:
  • Retry connection; clear browser cache; ensure network connectivity.
• Gmail authentication failed:
  • Verify OAuth2 credentials and Google Cloud Console settings; confirm Gmail API enabled.
• SMTP connection issues:
  • Validate server settings, ports, and security; check firewall and TLS configuration.
• Contact import errors:
  • Confirm file format compatibility and UTF-8 encoding; ensure proper column headers.

The status monitoring system provides reliable, real-time feedback for bulk messaging operations. It uses Electron IPC to deliver client lifecycle events, QR code generation, and per-message progress updates to the frontend. The UI integrates these events smoothly, enabling users to track sent/failed counts, monitor individual recipient statuses, and troubleshoot issues effectively.